Obtenga una lista de todas las plantillas
El punto final se utiliza para obtener una lista de todas las plantillas del sistema, incluidas las plantillas de vídeo, carrusel, imágenes, citas y memes. Este es un punto final paginado y, por lo tanto, recibirá una respuesta paginada.
URL de solicitud
- https://brain.predis.ai/predis_api/v1/get_templates/
Parámetros de solicitud
| Nombre | Descripción | Tipo | Valor por defecto | Valores posibles | Obligatorio |
|---|---|---|---|---|---|
brand_id | brand_id sirve como identificador único de su marca. Usando brand_id, también tendrás acceso a tus plantillas personalizadas en la primera página. | Cordón | None | YOUR_BRAND_ID | Sí |
media_type | Para obtener plantillas de un tipo de medio específico. | Cordón | single_image | single_image, carousel, video | No |
post_type | Para obtener plantillas de un tipo de publicación específico. Para meme y quotes post media_type debiera ser single_image. | Cordón | generic | generic, meme, quotes | No |
aspect_ratio | Para obtener plantillas de una relación de aspecto específica. | Cordón | all | square, portrait, landscape, all | No |
page_n | Indique el número de página para recuperar plantillas de esa página en particular. | Entero | 1 | 1, 2, 3...etc | No |
items_n | Indique el número deseado de plantillas para cada página. | Entero | 10 | 1, 2, 3...etc | No |
Ejemplo de respuesta exitosa
{
"templates": [{
"template_id": "...",
"media_type": "..."
}],
"total_pages": 50,
"errors": []
}
Ejemplo de respuesta de error
{
"errors": [{
"detail": "...",
"solution": "..."
}]
}
Códigos de respuesta
| Código de estado HTTP | Código de error | Mensaje de usuario | Solución recomendada |
|---|---|---|---|
| 429 | 001 | Número máximo de solicitudes alcanzado | Se alcanzó el número máximo de solicitudes por hora. Se le ha limitado la velocidad. Espere un momento y vuelva a intentarlo. |
| 400 | 002 | Inválido brand_id provea | Has proporcionado un inválido brand_id. Por favor proporcione una válida brand_id e inténtalo de nuevo. Leer más aquí |
| 400 | 003 | Los números de página del número de artículos no son válidos | Asegúrese de que el valor de page_n y items_n es un número entero |
| 400 | 004 | Previsto aspect_ratio no es apoyado | Asegúrese de que el valor de aspect_ratio El campo es compatible. Consulte los parámetros de solicitud en la tabla anterior para obtener más detalles. |
| 400 | 005 | El valor proporcionado para el media_type el campo no es válido | Asegúrese de que el valor sea uno de single_image, carousel or video |
| 400 | 006 | El valor proporcionado para el video_duration el campo no es válido | Asegúrese de que el valor sea short or long |
| 400 | 007 | El valor proporcionado para el post_type el campo no es válido | Asegúrese de que el valor sea generic, meme or quotes |
| 400 | 008 | El valor proporcionado para el post_type El campo no es válido para el dado. media_type | El proporcionado post_type y media_type La combinación de publicaciones aún no es compatible. Consulte los parámetros de solicitud en la tabla anterior para obtener más detalles. |
Limitación de la velocidad
Estándar API Se aplican límites de velocidad a este punto final. Lea más sobre los límites de tarifas aquí